This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/hspc-bmi
The HSPC specific profile for a body mass index observation
This profile was published on Tue, Jun 16, 2015 00:00+1000 as a draft by HSPC.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Observation.
Summary
Mandatory: 1 element
Fixed Value: 3 elements
Prohibited: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Observation.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | ||
status | 1..1 | code | Binding: ObservationStatusBasic (required) | |
code | 1..1 | CodeableConcept | Fixed Value: {"coding":[{"system":"http://loinc.org","code":"39156-5","display":"Body mass index (BMI) [Ratio]"}]} | |
issued | 0..0 | |||
performer | 0..* | Reference(HSPC ProviderPractitioner | HSPCOrganization | HSPC-Patient | RelatedPerson) | ||
valueQuantity | 1..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | ||
system | uri | Fixed Value: http://unitsofmeasure.org | ||
code | code | Fixed Value: kg/m2 | ||
dataAbsentReason | 0..0 | |||
interpretation | 0..1 | CodeableConcept | Binding: Abnormal Interpretation Numeric Nom (preferred) | |
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
hspc-extensionsdeltaFlag | 0..1 | CodeableConcept | Delta Flag URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag Binding: Abnormal Interpretation Numeric Nom (preferred) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: Component code SHALL not be same as observation code |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
hspc-extensionsdeltaFlag | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag Binding: Abnormal Interpretation Numeric Nom (preferred) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Unique Id for this particular observation | |
status | ?! ∑ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatusBasic (required) |
category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (example) | |
code | ∑ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) Fixed Value: {"coding":[{"system":"http://loinc.org","code":"39156-5","display":"Body mass index (BMI) [Ratio]"}]} |
subject | ∑ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what this is about |
encounter | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
effective[x] | ∑ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
performer | ∑ | 0..* | Reference(HSPC ProviderPractitioner | HSPCOrganization | HSPC-Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | ∑ | 1..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual result |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Abnormal Interpretation Numeric Nom (preferred) | |
comments | 0..1 | string | Comments about result | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
meaning | 0..1 | CodeableConcept | Indicates the meaning/use of this range of this range Binding: Observation Reference Range Meaning Codes (example) | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
related | ∑ | 0..* | BackboneElement | Resource related to this observation |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
type | 0..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) | |
target | 1..1 | Reference(Observation | QuestionnaireResponse) | Resource that is related to this one | |
component | ∑ | 0..* | BackboneElement | Component results |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | ∑ I | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
referenceRange | 0..* | See Observation.referenceRange | Provides guide for interpretation of component result | |
Documentation for this format |
todo
This structure is derived from Observation.
Summary
Mandatory: 1 element
Fixed Value: 3 elements
Prohibited: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Observation.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | ||
status | 1..1 | code | Binding: ObservationStatusBasic (required) | |
code | 1..1 | CodeableConcept | Fixed Value: {"coding":[{"system":"http://loinc.org","code":"39156-5","display":"Body mass index (BMI) [Ratio]"}]} | |
issued | 0..0 | |||
performer | 0..* | Reference(HSPC ProviderPractitioner | HSPCOrganization | HSPC-Patient | RelatedPerson) | ||
valueQuantity | 1..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | ||
system | uri | Fixed Value: http://unitsofmeasure.org | ||
code | code | Fixed Value: kg/m2 | ||
dataAbsentReason | 0..0 | |||
interpretation | 0..1 | CodeableConcept | Binding: Abnormal Interpretation Numeric Nom (preferred) | |
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
hspc-extensionsdeltaFlag | 0..1 | CodeableConcept | Delta Flag URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag Binding: Abnormal Interpretation Numeric Nom (preferred) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: Component code SHALL not be same as observation code |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
hspc-extensionsdeltaFlag | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag Binding: Abnormal Interpretation Numeric Nom (preferred) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Unique Id for this particular observation | |
status | ?! ∑ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatusBasic (required) |
category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (example) | |
code | ∑ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) Fixed Value: {"coding":[{"system":"http://loinc.org","code":"39156-5","display":"Body mass index (BMI) [Ratio]"}]} |
subject | ∑ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what this is about |
encounter | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
effective[x] | ∑ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
performer | ∑ | 0..* | Reference(HSPC ProviderPractitioner | HSPCOrganization | HSPC-Patient | RelatedPerson) | Who is responsible for the observation |
value[x] | ∑ | 1..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual result |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Abnormal Interpretation Numeric Nom (preferred) | |
comments | 0..1 | string | Comments about result | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
meaning | 0..1 | CodeableConcept | Indicates the meaning/use of this range of this range Binding: Observation Reference Range Meaning Codes (example) | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
related | ∑ | 0..* | BackboneElement | Resource related to this observation |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
type | 0..1 | code | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by Binding: ObservationRelationshipType (required) | |
target | 1..1 | Reference(Observation | QuestionnaireResponse) | Resource that is related to this one | |
component | ∑ | 0..* | BackboneElement | Component results |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | ∑ I | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
referenceRange | 0..* | See Observation.referenceRange | Provides guide for interpretation of component result | |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Observation.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Observation.extension [UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag]] | Abnormal Interpretation Numeric Nom | preferred | Abnormal Interpretation Numeric Nom |
Observation.status | ObservationStatusBasic | required | ObservationStatusBasic |
Observation.category | Observation Category Codes | example | Observation Category Codes |
Observation.code | LOINC Codes | example | LOINC Codes |
Observation.interpretation | Abnormal Interpretation Numeric Nom | preferred | Abnormal Interpretation Numeric Nom |
Observation.referenceRange.meaning | Observation Reference Range Meaning Codes | example | Observation Reference Range Meaning Codes |
Observation.related.type | ObservationRelationshipType | required | ObservationRelationshipType |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
Id | Path | Details | Requirements |
obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')]))) | |
obs-7 | Observation | Component code SHALL not be same as observation code XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0 | |
obs-3 | Observation.referenceRange | Must have at least a low or a high or text XPath: (exists(f:low) or exists(f:high)or exists(f:text)) |